/*
 * Copyright (c) 2009-2011, EzWare
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.Redistributions
 * in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or
 * other materials provided with the distribution.Neither the name of the
 * EzWare nor the names of its contributors may be used to endorse or
 * promote products derived from this software without specific prior
 * written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */


package org.oxbow.swingbits.table.filter;

import java.io.Serializable;
import java.util.Collection;

import javax.swing.JTable;
import javax.swing.table.TableModel;

public interface ITableFilter<T extends JTable> extends Serializable {

    /**
     * The table under filter
     * @return
     */
    T getTable();

    /**
     *
     * @param column model column index
     * @return
     */
    Collection<DistinctColumnItem> getDistinctColumnItems( int column );

    /**
     *
     * @param column model column index
     * @return
     */
    Collection<DistinctColumnItem> getFilterState( int column );

    /**
     * Checks if column is filtered
     * @param column model column index
     * @return true if column is filtered
     */
    boolean isFiltered( int column );

    boolean includeRow( Row entry );

    /**
     * Apply filter for specified column based on collection of distinct items
     * @param col
     * @param items
     * @return
     */
    boolean apply( int col, Collection<DistinctColumnItem> items );

    public interface Row {
        int getValueCount();
        Object getValue( int column );
    }

    void addChangeListener( IFilterChangeListener listener );
    void removeChangeListener( IFilterChangeListener listener );

    /**
     * Set flag to clear all columns filter if model row count is 0 
     * @param autoclean
     */
    void setAutoClean(boolean autoclean);
    
    /**
     * Clear the filter
     */
    void clear();

    /**
     * Describes what filter has to do when table model changes
     * @param model
     */
    void modelChanged( TableModel model );

    /**
     * Determines whether the table is sortable or not - Default true
     * @return true by default
     */

    void setSortable(boolean sortable);
    boolean getSortable();

}
